Fontes de Consultas Personalizadas
Returns presented by each of the custom query sources provided by Netrin. You can request access to these sources through suporte@netrin.com.br
Pessoa Física
KYC e Compliance
This API contains important data to comply with legal and regulatory requirements related to customer identification processes, called "know-your-client." This data includes information about politically exposed persons (PEP), sanctions and restrictions, nationally and internationally. The dataset includes flags that indicate if the individual is a PEP or has any restrictions, as well as historical records of these situations. There is also an Extended PEP concept that indicates if the person has any family relationship with PEP beyond the 1st degree or other types of relationships. The type of relationship is indicated in the search return, such as "mother" to indicate that the person is the mother of a PEP.
Parameters | Description |
---|---|
pep-kyc-cpf | Name of the service provided in the URL |
cpf | CPF of the person to be consulted |
acuracia | *Level for validating proximity to the returned data |
Note: The acuracia is an optional parameter that allows you to define the percentage of similarity between
- Return
{
"cpf": "00000000000",
"pepKyc": {
"currentlySanctioned": "Sim",
"last30DaysSanctions": 0,
"last90DaysSanctions": 0,
"last180DaysSanctions": 0,
"last365DaysSanctions": 0,
"currentlyPEP": "Não",
"lastYearOccurencePEP": 0,
"last3YearsOccurencePEP": 0,
"last5YearsOccurencePEP": 0,
"last5PlusYearsOccurencePEP": 0,
"historyPEP": [
{
"level": "",
"jobTitle": "",
"department": "",
"motive": "",
"startDate": "",
"endDate": ""
}
],
"SanctionsHistory": [
{
"source": "Fontes",
"type": "Lei",
"standardizedSanctionType": "Sanção",
"matchRate": 100,
"nameUniquenessScore": 1,
"startDate": "2020-01-01T00:00:00Z",
"endDate": "2020-01-01T00:00:00Z",
"details": {
Space for unique details of the returned sanction, optional implementation.
}
}
]
}
}
- Exception Return
API exceptions can be found on the definitions page, on the side tab.
Click here to go to the API Definitions.
- JSON Return Details
Key | Type | Description | Values |
---|---|---|---|
currentlySanctioned | string | Indicates whether there are active sanctions on the given CPF | SIM / NÃO |
last30DaysSanctions | int | Indicates the number of sanctions found on the given CPF in the last 30 days | - |
last90DaysSanctions | int | Indicates the number of sanctions found on the given CPF in the last 90 days | - |
last180DaysSanctions | int | Indicates the number of sanctions found on the given CPF in the last 180 days | - |
last365DaysSanctions | int | Indicates the number of sanctions found on the given CPF in the last 365 days | - |
currentlyPEP | string | Indicates whether the given CPF is present in the politically exposed persons (PEP) list or has any connection with any PEP | SIM / NÃO |
lastYearOccurencePEP | int | Indicates the number of times the given CPF was politically exposed in the last year | - |
last3YearsOccurencePEP | int | Indicates the number of times the given CPF was politically exposed in the last 3 years | - |
last5YearsOccurencePEP | int | Indicates the number of times the given CPF was politically exposed in the last 5 years | - |
last5PlusYearsOccurencePEP | int | Indicates the number of times the given CPF was politically exposed in more than 5 years ago | - |
historyPEP | array | Array containing information related to the CPF's exposure on the PEP list | - |
sanctionsHistory | array | Array containing information about the sanctions found associated with the given CPF | - |
Pessoas Impedida de Apostar (LEI 14.790/23)
The People Barred from Betting API is a crucial tool to ensure strict compliance with Law 14,790/23, which establishes essential Know Your Customer (KYC) requirements for sports betting. This service not only identifies individuals with betting restrictions under the law but also their direct or indirect involvement with sports institutions. Additionally, it provides comprehensive information about their professional history, along with specific details about the entity to which they are linked. By prioritizing compliance with the stringent standards of the legislation, the API stands out as a fundamental ally in ensuring integrity and compliance in activities related to sports betting, aiding in decision-making.
Parameters | Description |
---|---|
pessoas-impedidas-apostar | Name of the service provided in the URL |
cpf | CPF of the person to be consulted |
- Return
{
"cpf": "000000000",
"pessoasImpedidasApostar": {
"dadosCpf": {
"documento": "0000000000",
"nome": "NOME SOBRENOME",
"restricoes": [
{
"vinculoNivel": "0",
"restricaoTipo": "atleta",
"esporte": "futebol",
"entidade": "EC Sao Bernardo SP",
"cargoFuncao": "",
"documentoRelacionado": "00000000",
"tipoDocumentoRelacionado": "CPF",
"nomeRelacionado": "NOME SOBRENOME",
"dataAtualizacao": "2024-02-09"
}
]
}
}
}
- Exception Return
API exceptions can be found on the definitions page, on the side tab.
Click here to go to the API Definitions.
- JSON Return Details
Key | Type | Description | Values |
---|---|---|---|
documento | string | Research document conducted | - |
nome | string | Name of the Person linked to the CPF | - |
restricoes.vinculoNivel | string | Nível do vínculo do CPF | 0 for when the CPF itself is included, 1 for when the CPF is linked to a first-degree relative or spouse, 2 for when the CPF is linked to a second-degree relative |
restricoes.restricaoTipo | string | Type of restriction attached to the law | agente-operador, agente-publico, agente-sistemas, funcionario, arbitragem, agente-intemediario, agente-fiscalizador e atleta |
restricoes.esporte | string | Sports category associated with the CPF | - |
restricoes.entidade | string | Organization or institution related to the CPF | - |
restricoes.cargoFuncao | string | Position held by the CPF | - |
restricoes.documentoRelacionado | string | Reference to associated or linked documents | - |
restricoes.nomeRelacionado | string | Identification of names associated with the CPF | - |
restricoes.dataAtualizacao | string | Link update date | - |
NOTE family relationship classification:
1 - by affinity: spouse and first-degree relative in a straight line corresponds to father, mother, son, and daughter.
2 - Second-degree relative in a straight line corresponds to grandfather, grandmother, and second-degree collateral: brother and sister.
Type of Restriction | Description |
---|---|
agente-operador | Used for individuals related to the administration of betting houses, it can be the owner, administrator, director, person with significant influence, manager, or employee. Subsection II |
agente-publico | Used for public administration individuals with duties directly related to the regulation, control, and supervision of the activity. Subsection III. |
agente-sistemas | Used for individuals who have or may have access to computerized betting systems. Subsection IV. |
comissao-tecnica | Utilizado para pessoas que exerçam cargo de dirigente, técnico ou membro de comissão técnica. Inciso V letra a. |
arbitragem | Used for individuals involved in refereeing, assistant referees, and so on. Subsection V, letter b. |
agente-intermediario | Used for sports entrepreneurs, athlete agents, coach agents, or members of the technical commission. Subsection V, letter b. |
agente-fiscalizador | Used for members of the management or oversight body of an entity administering or organizing a sports competition or event. Subsection V, letter c. |
atleta | Used for athletes participating in competitions organized by entities that are part of the National Sports System. Subsection V, letter d. |
The return will consist of all possible restrictions linked to that CPF, as this impacts decision-making assistance.
Empresas Relacionadas ao CPF
The query Check companies related to the CPF allows you to search for companies associated with the consulted CPF (Brazilian Individual Taxpayer Registry).
Parameters | Description |
---|---|
empresas-relacionadas-cpf | Name of the service informed in the URL |
cpf | CPF of the person to be consulted |
Example: https://api.netrin.com.br/v1/consulta-composta?token=0000&s=empresas-relacionadas-cpf&cpf=0000
- Return
{
"cpf": "20374070253",
"empresasRelacionadasCPF": {
"negociosRelacionados": [
{
"entidadeRelacionadaDocumento": "00000000",
"entidadeRelacionadadaTipoDeDocumento": "CNPJ",
"entidadeRelacionadaPais": "Brazil",
"entidadeRelacionadaNome": "NOME LTDA",
"tipoDeRelacionamento": "OWNERSHIP",
"nivelDeRelacionamento": "DIRECT",
"dataInicioRelacionamento": "1996-01-11T00:00:00Z",
"dataFimRelacionamento": "9999-12-31T23:59:59.9999999",
"dataCriacao": "2017-01-01T00:00:00Z",
"ultimaAtualizacao": "2023-07-21T00:00:00Z"
},
]
}
}
- Exception Return
API exceptions can be found on the definitions page, on the side tab.
Click here to go to the API Definitions.
- JSON Return Details
Key | Type | Description | Values |
---|---|---|---|
entidadeRelacionadaDocumento | string | Document of the related company | - |
entidadeRelacionadadaTipoDeDocumento | string | Type of the returned document | - |
entidadeRelacionadaPais | string | Country of the related company | - |
entidadeRelacionadaNome | string | Legal name of the related company | - |
tipoDeRelacionamento | string | Type of the relationship between the CPF and the company | - |
nivelDeRelacionamento | string | Level of the relationship between the CPF and the company | - |
dataInicioRelacionamento | string | Date of the start of the relationship between the CPF and the company | - |
dataFimRelacionamento | string | Date of the end of the relationship between the CPF and the compan | - |
dataCriacao | string | Date of the creation of the link | - |
ultimaAtualizacao | string | Last update of the link | - |
Score e Renda Presumida CPF
This service provides a simplified analysis of the credit score based on presumed income for individuals.
Parameters | Description |
---|---|
score-credito-renda-presumida-pf-simplificado | Name of the service provided in the URL |
cpf | CPF of the individual to be consulted |
- Return
{
"cpf": "00000000",
"scoreCreditoRendaPresumidaPFSimplificado": {
"name": "NOME SOBRENOME",
"cpf": 0000000,
"scoreCredito": {
"D00": 000,
"D30": 00,
"D60": 00
},
"renda": {
"individual": 0000.00,
"empresarial": "",
"familiar": 0000.00,
"presumido": 0000.00,
"classeSocialPessoal": 0,
"classeSocialFamiliar": 0,
"aponsentadoria": ""
}
}
}
- Exception Return
API exceptions can be found on the definitions page, on the side tab.
Click here to go to the API Definitions.
- JSON Return Details
Key | Type | Description | Values |
---|---|---|---|
name | string | Name of the person linked to the CPF | - |
cpf | string | Document used for the search | - |
scoreCredito.D00 | string | Current credit score | - |
scoreCredito.D30 | string | Credit score from 30 days ago | - |
scoreCredito.D60 | string | Credit score from 60 days ago | - |
renda.individual | float | Value of individual income | - |
renda.empresarial | float | Value of business income | - |
renda.familiar | float | Value of family income | - |
renda.presumido | float | Value of presumed income | - |
renda.classeSocialPessoal | float | Personal social class | Person's social class: 0:A / 1:B / 2:C / 3:D / 4:E |
renda.classeSocialFamiliar | float | Family social class | Family social class: 0:A / 1:B / 2:C / 3:D / 4:E |
renda.aponsentadoria | float | Income from retirement | - |
Dados Bancários
To mitigate issues arising from the misuse of the service, NETRIN continuously monitors the number of validation errors performed within a specific time frame and applies to the client the same rule as the BACEN Pix Arrangement, which sets an acceptable error percentage. If this percentage is exceeded, NETRIN will temporarily suspend the validation returns accepted by the service. In this case, internal code 621 will be returned to the client as an alert. If misuse is detected, NETRIN may permanently suspend the service, and code 622 will be returned.
The limits are adjusted based on the client's behavior, with the standard determining that if 50 errors occur within a 10-minute window, the alert code will be triggered.
Validação chave PIX
The PIX key validation API allows for the verification of authenticity and validity of a key registered in the PIX system. This API works by verifying whether the key provided complies with the rules defined by the Central Bank of Brazil for the registration of PIX keys, such as the composition, size, and type of key.
Parameters | Description |
---|---|
valida-pix | Name of the service informed in the URL |
chave-pix | Pix key to be consulted |
tipo-chave | Type of pix key (CHAVE_ALEATORIA / EMAIL / TELEFONE / CPF / CNPJ) |
documento | *CPF or CNPJ number of the account holder for validation with the returned account |
description | *Description of up to 140 characters to explain the reason for the deposit, for example: deposit made by company X for bank data verification |
Note1: The "documento" parameter is optional.
- Return
{
"chave-pix": "00000000000",
"validaPix": {
"validacaoConta": "Sim",
"reciboBanco": "https://...",
"codigoIdentificacao": "0000",
"microDepositoValor": 0.01,
"microDepositoStatus": "Sim",
"dataValidacao": "2021-01-29T10:11:06.000Z",
"erros": [
{
"mensagem": "CPF/CNPJ informado para pagamento diverge com o CPF/CNPJ do titular da chave"
},
{
"mensagem": "Formato de documento inválido"
}
],
"conta": {
"nome": "Nome do Recebedor",
"cpfCnpj": "000.000.000-00",
"codigoBanco": "200",
"agencia": "000",
"conta": "000000",
"contaDigito": "0",
"contaTipo": "CONTA_CORRENTE",
"pixChave": "pix-key@netrin.com",
"pixTipoChave": "EMAIL",
"pixChaveValida": {
"cpfCnpj": "000.000.000-00"
}
}
}
}
- Exception Return
API exceptions can be found on the definitions page, on the side tab.
Click here to go to the API Definitions.
- JSON Return Details
Key | Type | Description | Values |
---|---|---|---|
validacaoConta | string | Indicates whether the account is valid, if it is null, the validation has not yet been completed | SIM / NÃO / null |
reciboBanco | link | Bank receipt URL (if available) | - |
codigoIdentificacao | string | Bank transaction identification code | - |
microDepositoValor | string | Amount of the micro deposit made | - |
microDepositoStatus | string | Indicates whether the micro deposit was made, null (still in processing) or validated (micro deposit completed) | null / VALIDADO |
dataValidacao | string | Date when the validation was performed | - |
erros | array | List of errors if any | - |
nome | string | Account name | - |
cpfCnpj | string | Account document number | - |
codigoBanco | string | Bank code of the account | - |
agencia | string | Account agency | - |
conta | string | Account number | - |
contaDigito | string | Account digit | - |
contaTipo | string | Account type | - |
pixChave | string | Pix key of the account | - |
pixTipoChave | string | Pix key type of the account | - |
pixChaveValida | string | Document provided for account validation | - |
Antifraude PIX
The Antifraud PIX API is a security tool that aims to prevent fraud in financial transactions made via PIX, the instant payment system of the Central Bank of Brazil. To increase transaction security, the API offers users the ability to set the value for a micro deposit, which can be used as a form of account confirmation.
Parameters | Description |
---|---|
antifraude-pix | Name of the service informed in the URL |
chave-pix | Pix key to be consulted |
tipo-chave | Type of pix key (CHAVE_ALEATORIA / EMAIL / TELEFONE / CPF / CNPJ) |
valor-pix | Value of the PIX between (0.01 and 1.00) |
documento | *CPF or CNPJ number of the account holder for validation with the returned account |
description | *Description of up to 140 characters to explain the reason for the deposit, for example: deposit made by company X for bank data verification |
Note1: The "documento" parameter is optional.
- Return
{
"chave-pix": "00000000000",
"antifraudePix": {
"validacaoConta": "Sim",
"reciboBanco": "https://...",
"codigoIdentificacao": "0000",
"microDepositoValor": 0.12,
"microDepositoStatus": "Sim",
"dataValidacao": "2021-01-29T10:11:06.000Z",
"erros": [
{
"mensagem": "CPF/CNPJ informado para pagamento diverge com o CPF/CNPJ do titular da chave"
},
{
"mensagem": "Formato de documento inválido"
}
],
"conta": {
"nome": "Nome do Recebedor",
"cpfCnpj": "000.000.000-00",
"codigoBanco": "200",
"agencia": "000",
"conta": "000000",
"contaDigito": "0",
"contaTipo": "CONTA_CORRENTE",
"pixChave": "pix-key@netrin.com",
"pixTipoChave": "EMAIL",
"pixChaveValida": {
"cpfCnpj": "000.000.000-00"
}
}
}
}
- Exception Return
API exceptions can be found on the definitions page, on the side tab.
Click here to go to the API Definitions.
- JSON Return Details
Key | Type | Description | Values |
---|---|---|---|
validacaoConta | string | Indicates whether the account is valid, if it is null, the validation has not yet been completed | SIM / NÃO / null |
reciboBanco | link | Bank receipt URL (if available) | - |
codigoIdentificacao | string | Bank transaction identification code | - |
microDepositoValor | string | Value of the micro deposit informed in the validation request | - |
microDepositoStatus | string | Indicates whether the micro deposit was made, null (still in processing) or validated (micro deposit completed) | null / VALIDADO |
dataValidacao | string | Date when the validation was performed | - |
erros | array | List of errors if any | - |
nome | string | Account name | - |
cpfCnpj | string | Account document number | - |
codigoBanco | string | Bank code of the account | - |
agencia | string | Account agency | - |
conta | string | Account number | - |
contaDigito | string | Account digit | - |
contaTipo | string | Account type | - |
pixChave | string | Pix key of the account | - |
pixTipoChave | string | Pix key type of the account | - |
pixChaveValida | string | Document provided for account validation | - |
Validação da Conta Bancária
The Bank Account Validation API allows you to verify the authenticity of bank account data. To enhance transaction security, the API offers users the option to set a value for a microdeposit, which can be used as a means of confirming the account.
Parameters | Description |
---|---|
valida-conta-bancaria | Name of the service informed in the URL |
cpf-cnpj | CPF or CNPJ number of the account holder |
codigo-banco | Bank code number |
agencia | Branch number |
conta | Account number |
digito-conta | Account digit |
tipo-conta | Account type (CONTA_CORRENTE / CONTA_POUPANCA / CONTA_PAGAMENTO / CONTA_FACIL / ENTIDADES_PUBLICAS) |
valor-deposito | *Deposit amount between (0.01 and 1.00) |
description | *Description of up to 140 characters to explain the reason for the deposit, for example: deposit made by company X for bank data verification |
Note1: The "valor-deposito" parameter is optional.
- Return
{
"cpf-cnpj": "00000000000",
"validaContaBancaria": {
"validacaoConta": "Sim",
"reciboBanco": "https://...",
"codigoIdentificacao": "0000",
"microDepositoValor": 0.12,
"microDepositoStatus": "VALIDADO",
"dataValidacao": "2021-01-29T10:11:06.000Z",
"erros": [
{
"mensagem": "CPF/CNPJ informado para pagamento diverge com o CPF/CNPJ do titular da chave"
},
{
"mensagem": "Formato de documento inválido"
}
],
"conta": {
"agencia": "0001",
"conta": "7069935",
"cpfCnpj": "01773375083",
"codigoBanco": "0260",
"contaTipo": "CONTA_POUPANCA",
"contaDigito": "0"
}
}
}
- Exception Return
API exceptions can be found on the definitions page, on the side tab.
Click here to go to the API Definitions.
- JSON Return Details
Key | Type | Description | Values |
---|---|---|---|
validacaoConta | string | Indicates whether the account is valid, if it is null, the validation has not yet been completed | SIM / NÃO / null |
reciboBanco | link | Bank receipt URL (if available) | - |
codigoIdentificacao | string | Bank transaction identification code | - |
microDepositoValor | string | Value of the micro deposit informed in the validation request | - |
microDepositoStatus | string | Indicates whether the micro deposit was made, null (still in processing) or validated (micro deposit completed) | null / VALIDADO |
dataValidacao | string | Date when the validation was performed | - |
erros | array | List of errors if any | - |
agencia | string | Account agency | - |
conta | string | Account number | - |
cpfCnpj | string | Account document number | - |
codigoBanco | string | Bank code of the account | - |
contaTipo | string | Account type | - |
contaDigito | string | Account digit | - |
Pessoa Jurídica
KYC e Compliance
This API contains important data to fulfill legal and regulatory requirements related to customer identification processes, known as "know-your-client." It encompasses not only data about politically exposed persons (PEP) and lists of sanctions and restrictions, both at the national and international levels, but also includes indicators that determine whether the company (or one of its partners) is classified as a PEP or has any associated restrictions. The dataset includes flags indicating whether the company is a PEP or has any restrictions, along with historical records of these situations.
Parameters | Description |
---|---|
pep-kyc-cnpj | Name of the service provided in the URL |
CNPJ | Tax ID (CNPJ) of the company to be consulted |
acuracia | *Level for validating proximity to the returned data |
Note: The acuracia is an optional parameter that allows you to define the percentage of similarity between
- Return
{
"cnpj": "00000000000",
"pepKycCNPJ": {
"currentlySanctioned": "Sim",
"last30DaysSanctions": 0,
"last90DaysSanctions": 0,
"last180DaysSanctions": 0,
"last365DaysSanctions": 0,
"currentlyPEP": "Não",
"lastYearOccurencePEP": 0,
"last3YearsOccurencePEP": 0,
"last5YearsOccurencePEP": 0,
"last5PlusYearsOccurencePEP": 0,
"historyPEP": [
{
"level": "",
"jobTitle": "",
"department": "",
"motive": "",
"startDate": "",
"endDate": ""
}
],
"SanctionsHistory": [
{
"source": "Fontes",
"type": "Lei",
"standardizedSanctionType": "Sanção",
"matchRate": 100,
"nameUniquenessScore": 1,
"startDate": "2020-01-01T00:00:00Z",
"endDate": "2020-01-01T00:00:00Z",
"details": {
Space for unique details of the returned sanction, optional implementation.
}
}
]
}
}
- Exception Return
API exceptions can be found on the definitions page, on the side tab.
Click here to go to the API Definitions.
- JSON Return Details
Key | Type | Description | Values |
---|---|---|---|
currentlySanctioned | string | Indicates whether there are active sanctions on the given CPF | SIM / NÃO |
last30DaysSanctions | int | Indicates the number of sanctions found on the given CPF in the last 30 days | - |
last90DaysSanctions | int | Indicates the number of sanctions found on the given CPF in the last 90 days | - |
last180DaysSanctions | int | Indicates the number of sanctions found on the given CPF in the last 180 days | - |
last365DaysSanctions | int | Indicates the number of sanctions found on the given CPF in the last 365 days | - |
currentlyPEP | string | Indicates whether the given CPF is present in the politically exposed persons (PEP) list or has any connection with any PEP | SIM / NÃO |
lastYearOccurencePEP | int | Indicates the number of times the given CPF was politically exposed in the last year | - |
last3YearsOccurencePEP | int | Indicates the number of times the given CPF was politically exposed in the last 3 years | - |
last5YearsOccurencePEP | int | Indicates the number of times the given CPF was politically exposed in the last 5 years | - |
last5PlusYearsOccurencePEP | int | Indicates the number of times the given CPF was politically exposed in more than 5 years ago | - |
historyPEP | array | Array containing information related to the CPF's exposure on the PEP list | - |
sanctionsHistory | array | Array containing information about the sanctions found associated with the given CPF | - |
Pessoas Relacionadas ao CNPJ
The query "Pessoas Relacionadas ao CNPJ" allows searching for individuals linked to the consulted CNPJ (Brazilian National Registry of Legal Entities).
Parameters | Description |
---|---|
pessoas-relacionadas-cnpj | Name of the service provided in the URL |
cnpj | Tax ID (CNPJ) of the company to be consulted |
Ex: https://api.netrin.com.br/v1/consulta-composta?token=0000&s=pessoas-relacionadas-cnpj&cnpj=000000
- Return
{
"cnpj": "0000000000000",
"pessoasRelacionadasCNPJ": {
"entidadesRelacionadas": [
{
"entidadeRelacionadaDocumento": "0000000",
"entidadeRelacionadadaTipoDeDocumento": "CPF",
"entidadeRelacionadaPais": "Brazil",
"entidadeRelacionadaNome": "NOME SOBRENOME",
"tipoDeRelacionamento": "QSA",
"vinculoDoRelacionamento": "SOCIO-ADMINISTRADOR",
"nivelDeRelacionamento": "Direct",
"origemRelacionamento": "RECEITA FEDERAL",
"dataInicioRelacionamento": "1997-08-04T00:00:00Z",
"dataFimRelacionamento": "9999-12-31T23:59:59.9999999",
"dataCriacao": "2021-02-13T00:00:00Z",
"ultimaAtualizacao": "2024-01-14T00:00:00Z"
},
{
"entidadeRelacionadaDocumento": "0000000",
"entidadeRelacionadadaTipoDeDocumento": "CPF",
"entidadeRelacionadaPais": "Brazil",
"entidadeRelacionadaNome": "NOME SOBRENOME",
"tipoDeRelacionamento": "QSA",
"vinculoDoRelacionamento": "SOCIO-ADMINISTRADOR",
"nivelDeRelacionamento": "Direct",
"origemRelacionamento": "RECEITA FEDERAL",
"dataInicioRelacionamento": "1997-08-04T00:00:00Z",
"dataFimRelacionamento": "9999-12-31T23:59:59.9999999",
"dataCriacao": "2021-02-13T00:00:00Z",
"ultimaAtualizacao": "2024-01-14T00:00:00Z"
}
]
}
}
- Exception Return
API exceptions can be found on the definitions page, on the side tab.
Click here to go to the API Definitions.
- JSON Return Details
Key | Type | Description | Values |
---|---|---|---|
entidadeRelacionadaDocumento | string | Document of the related person | - |
entidadeRelacionadadaTipoDeDocumento | string | Type of returned document | - |
entidadeRelacionadaPais | string | Country of the related person | - |
entidadeRelacionadaNome | string | Name of the related person | - |
tipoDeRelacionamento | string | Type of relationship between CPF and the company | - |
tipoDeRelacionamento | string | Description of the link between CPF and the company | - |
nivelDeRelacionamento | string | Level of the relationship between CPF and the company | - |
origemRelacionamento | string | Origin of the information about the relationship between CPF and the company | - |
dataInicioRelacionamento | string | Date of the start of the relationship between CPF and the company | - |
dataFimRelacionamento | string | Date of the end of the relationship between CPF and the company | - |
dataFimRelacionamento | string | Date of the link creation | - |
ultimaAtualizacao | string | Last update of the link | - |
Score e Renda Presumida CNPJ
This service provides a simplified analysis of the credit score based on presumed income for legal entities
Parameters | Description |
---|---|
score-credito-faturamento-pj-simplificado | Name of the service provided in the URL |
cnpj | CNPJ of the entity to be consulted |
- Response
{
"cnpj": "00000000",
"scoreCreditoFaturamentoPJSimplificado": {
"name": "RAZÃO SOCIAL",
"cnpj": 00000000,
"scoreCredito": {
"D00": 000,
"D30": 0,
"D60": 0
},
"faturamento": {
"capitalSocial": 0.0,
"presumidoIndividual": 0.0,
"presumidoGrupo": 0.0,
"regimeImposto": 0,
"porte": "DEMAIS",
"naturezaJuridica": "Produtor Rural (Pessoa Física)"
}
}
}
- Exception Return
API exceptions can be found on the definitions page, on the side tab.
Click here to go to the API Definitions.
- JSON Return Details
Key | Type | Description | Values |
---|---|---|---|
name | string | Company name associated with the CNPJ | - |
cnpj | string | Document used for the query | - |
scoreCredito.D00 | string | Current credit score | - |
scoreCredito.D30 | string | Credit score 30 days ago | - |
scoreCredito.D60 | string | Credit score 60 days ago | - |
faturamento.capitalSocial | float | Company's capital stock | - |
faturamento.presumidoIndividual | float | Presumed individual income | - |
faturamento.presumidoGrupo | float | Presumed group income | - |
faturamento.regimeImposto | int | Tax regime | 0 = Presumed Profit / 1 = Actual Profit / 2 = Simples Nacional |
faturamento.porte | string | Company size | - |
faturamento.naturezaJuridica | string | Company's legal nature | - |